<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.PartitionTable: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Partition.html" title="org.freedesktop.UDisks2.Partition">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Filesystem.html" title="org.freedesktop.UDisks2.Filesystem">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.PartitionTable.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.PartitionTable.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Partition.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Filesystem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.PartitionTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-PartitionTable.top_of_page"></a>org.freedesktop.UDisks2.PartitionTable</span></h2>
<p>org.freedesktop.UDisks2.PartitionTable — Block device containing a partition table</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition" title="The CreatePartition() method">CreatePartition</a>          (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          OUT o     created_partition);
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartitionAndFormat" title="The CreatePartitionAndFormat() method">CreatePartitionAndFormat</a> (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          IN  s     format_type,
                          IN  a{sv} format_options,
                          OUT o     created_partition);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.8.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-property-org-freedesktop-UDisks2-PartitionTable.Partitions" title='The "Partitions" property'>Partitions</a>  readable   ao
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type" title='The "Type" property'>Type</a>        readable   s
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-PartitionTable"></a><h2>Description</h2>
<p>      This interface is used for <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
      devices that contain a partition table.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.PartitionTable"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition"></a><h3>The CreatePartition() method</h3>
<pre class="programlisting">
CreatePartition (IN  t     offset,
                 IN  t     size,
                 IN  s     type,
                 IN  s     name,
                 IN  a{sv} options,
                 OUT o     created_partition);
</pre>
<p>        Creates a new partition.
</p>
<p>        Note that the created partition won't necessarily be created
        at the exact <em class="parameter"><code>offset</code></em> but slightly behind due to disk geometry
        and other alignment constraints (e.g. 1MiB alignment).
</p>
<p>        The newly created partition may also end up being slightly
        larger than the requested <em class="parameter"><code>size</code></em> bytes for the same reasons.
        The maximal size can be automatically set by using 0 as size.
</p>
<p>        For <code class="literal">dos</code> partition tables, the partition type can be
        set with the <em class="parameter"><code>partition</code></em>-type option. Possible values are: "primary",
        "extended" or "logical".
</p>
<p>        The newly created partition will be wiped of known filesystem
        signatures using the
        <span class="citerefentry"><span class="refentrytitle">wipefs</span>(8)</span>
        command.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>offset</code></em></code>:</span></p></td>
<td><p>The desired offset where the partition should be created, in bytes.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>The desired size of the partition, in bytes (0 for maximal size).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The type of partition to create (cf. the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a> property) or blank to use the default for the partition table type and OS.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>The name for the new partition or blank if the partition table do not support names.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) include <em class="parameter"><code>partition-type</code></em> (of type 's').</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td>
<td><p>An object path to the created block device object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a> interface.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartitionAndFormat"></a><h3>The CreatePartitionAndFormat() method</h3>
<pre class="programlisting">
CreatePartitionAndFormat (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          IN  s     format_type,
                          IN  a{sv} format_options,
                          OUT o     created_partition);
</pre>
<p>        This is a combination of
        <a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-interface-org-freedesktop-UDisks2-PartitionTable.top_of_page">org.freedesktop.UDisks2.PartitionTable</a>:CreatePartition and
        <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>:Format.  After creating the
        partition, the resulting block device is formatted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>offset</code></em></code>:</span></p></td>
<td><p>The desired offset where the partition should be created, in bytes.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>The desired size of the partition, in bytes (0 for maximal size).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The type of partition to create (cf. the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a> property) or blank to use the default for the partition table type and OS.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>The name for the new partition or blank if the partition table do not support names.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) include <em class="parameter"><code>partition-type</code></em> (of type 's').</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>format_type</code></em></code>:</span></p></td>
<td><p>The type to use for Format.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>format_options</code></em></code>:</span></p></td>
<td><p>Options for Format.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td>
<td><p>An object path to the created block device object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a> interface.</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.PartitionTable"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Partitions"></a><h3>The "Partitions" property</h3>
<pre class="programlisting">
Partitions  readable   ao
</pre>
<p>List of object paths of the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a></p>
<p>         objects that belongs to this partition table.
         <em class="parameter"><code>since</code></em>: 2.7.2
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type"></a><h3>The "Type" property</h3>
<pre class="programlisting">
Type  readable   s
</pre>
<p>The type of partition table detected.</p>
<p>         Known values include:
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">dos</span></p></td>
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/Master_Boot_Record" target="_top">Master Boot Record</a></p></td>
</tr>
<tr>
<td><p><span class="term">gpt</span></p></td>
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/GUID_Partition_Table" target="_top">GUID Partition Table</a></p></td>
</tr>
</tbody>
</table></div>
<p>
         If blank it means that a partition table was detected but its
         scheme is unknown.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>